home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1995 October / EnigmA AMIGA RUN 01 (1995)(G.R. Edizioni)(IT)[!][issue 1995-10][Aminet 7].iso / Aminet / comm / tcp / ezl1_0.lha / ezl.docs < prev    next >
Text File  |  1995-06-18  |  11KB  |  298 lines
  1.  
  2.             EZ-List v1.0
  3.              © 1995 Schrödinger's Cat Software
  4.                          by 
  5.                  Jeffrey S. Morgan
  6.  
  7.  
  8.                              Introduction:
  9.  
  10. EZ-List is a mailing list manager for the Amiga. It offers some of
  11. the features of the UNIX version as well as some amiga specific 
  12. ones.  With minimal installation you can run your own mailing
  13. list server from your own SLIP account. 
  14.  
  15.  
  16. Requirements
  17.  
  18. 1-OS 2.0x since AmiTCP requires it.
  19. 2-AmiTCP installed and running
  20. 3-InetUtils 1.14 (actually you only need the SMTP.d demon working)
  21. 4-Putmail (Included)
  22. 5-SLIP/PPP connection
  23. 6-EZ-List v1.0 :)
  24.  
  25.  
  26.  
  27.                              Installation:
  28.  
  29. Now this is very important. You should follow these instructions to the letter
  30. if you hope to get this thing up and running. There is very little "getting into
  31. the guts" to install this, but you do need to know how to use a shell and an
  32. editor.
  33.  
  34. First, after you have made sure that you have requirements 2 and 3 up and installed
  35. then you can risk de-archiving EZ-List. 
  36.  
  37. 1- Create a drawer where you want EZ-List to reside.
  38. 2- De-lha the files into this drawer.
  39. 3- Add the following to your s:user-startup sequence
  40.     assign EZ-List: <drawer>
  41. 4- Edit the configuration file to suit your needs. It is commented to
  42. help ease your way.
  43. 5- Read the following:
  44.     SMTPpost, when receiving mail, will invoke a command if it is set. This
  45. variable may be set many ways, but the way I have chosen to implement it is
  46. via the aliases file.  This file may be located in one of several places,
  47. but for ease of use it should be located in Amitcp:db/.  The file serves many
  48. purposes which inlude rerouting mail, making copies to other drawers, and best of all
  49. running other programs.  
  50.  
  51. For EVERY list you plan to run, it MUST have an entry in the aliases file.
  52. An entry looks like this:
  53.  
  54. programming: \programming, "|ezl programming"
  55.  
  56.   ^^^            ^^^              ^^^
  57.    1              2                3
  58.  
  59.     1-list name smtp.d looks for
  60.     2-file the mail gets copied to
  61.     3-program (in this case EZL) to run when mail for this list arrives
  62.           along with the name of the list to speed up the process
  63.  
  64. You do not need to know the purpose of 1-3, but that is the purpose of the entry.
  65.  
  66. NOTE***If there is not an entry for each list here then ezl will not
  67. be run and mail will not be sent out.
  68.  
  69.  
  70. 6a- Copy the executable EZL to Amitcp:bin and do the same with Putmail.
  71. 6b- Read the PutMail docs on how to decide which Putmail is right for you.
  72. 7- Edit the EZL text files accordingly. See the next section on the structure
  73. of files for EZL.
  74.  
  75.  
  76.                             Using EZ-List:
  77.  
  78. This is how EZ-List works.
  79.  
  80. Say you have a mailing list called:
  81.  
  82. programming
  83.  
  84. When mail comes in, smtp.d will grab it, deliver it, and run the command
  85. stored in the aliases file in amitcp:db/. EZL then is run. It searches
  86. MAILDIR (assigned by the config file)  and if it finds mail with the name PROGRAMMING
  87. then it copies it to T: with a random name to avoid conflict and then deletes
  88. the original. It then opens up a file called EZ-LIST:PROGRAMMING.NAMES (case is unimportant)
  89. and in it are stored addresses. The mail is then appended by a .sig file (see section
  90. on creating text files) and then mailed to all the names in the .names file.
  91. The temporary file is then deleted and logging is accomplished. See the section
  92. on logging for more details.
  93.  
  94. When someone subscribes (see subscribing section) it comes as the name MAJORDOMO
  95. to your address. EZL checks for this file first. If it finds one, the mail
  96. is then parsed for the correct subscribing command and the FROM: header is 
  97. extracted.  If a REPLY-TO: header is found as well, it is used for subscribing.
  98. The address found in the From: header is then added to the .names file.
  99. The same principle applies for UNSUBSCRIBING except that the name is then
  100. REMOVED from the .names file.
  101.  
  102.  
  103.                              Special Commands:
  104.  
  105. To subscribe to a list you must first have the list in the config file
  106. added. When you edit the config file, choose the name of a list you
  107. want started and enter its name.
  108.  
  109. IMPORTANT***Do not have any blank lines between list names. You may have
  110. 20 separate lists and if there is not a list for a line then leave the
  111. <empty> in place.
  112.  
  113.  
  114. A person will send mail to:
  115.  
  116. majordomo@your_machine.your_domain
  117.  
  118. In the body there must be the words:
  119.  
  120. (un)subscribe <list name> (brackets not included)
  121.  
  122. No need to add the address as EZL pulls that from the headers.
  123.  
  124. Other commands accepted at this time are:
  125.  
  126. HELP
  127. INFORMATION <LIST>
  128. RELEASE
  129. LISTS
  130.  
  131.  
  132. In future releases, more commands will be added to handle the common
  133. UNIX subset such as:
  134.  
  135. recipients
  136. digest
  137. file commands
  138.  
  139.  
  140.  
  141.                              Special Files:
  142.  
  143. There are several files you should have to make your lists more
  144. esthetically pleasing. Assuming the list name is PROGRAMMING, you
  145. can have the following files:
  146.  
  147. programming.welcome   -- a plain text file with a welcome and hints
  148. programming.sig       -- a text file with a sig to append to your mail
  149. programming.inf           -- a text file with specific information on that
  150.              list
  151. There is also an error file called...error. :) 
  152.  
  153. It is sent back to a sender when they issue an unknown command to the
  154. list. EZL will also append the original message for the sender to review
  155. what they truly sent in case of temporary fumble-fingered-ness.
  156. You may edit this file according to your preference.
  157.  
  158. The HELP file is included for the list command HELP. When it is received
  159. this file is sent out. Should it not exist then an error will be generated
  160. and it will be logged and the error file will be sent. The same holds true
  161. for the RELEASE file and .inf files.
  162.  
  163. Sample files are included which you may, of course, edit.
  164.  
  165.  
  166.  
  167.                              LOGGING:
  168.  
  169. In the config file there is a place to designate where you want
  170. your logfile to be created. I suggest in ez-list:. EZL will
  171. log every mail sent out including when it was sent.
  172.  
  173. Below is a sample log:
  174.  
  175.  
  176. SYSOP@SCAT.CYBERNETICS.NET (JEFFREY MORGAN) has subscribed to TESTLIST on 06-06-1995 at 07:14:29
  177. smitty@scat.cybernetics.net has subscribed to TESTLIST on 06-06-1995 at 07:19:39
  178. Removed <smitty@scat.cybernetics.net> from list: on 06-06-1995 at 07:20:39
  179. snapper@scat.cybernetics.net (Jeffrey Morgan) has subscribed to TESTLIST on 06-06-1995 at 18:18:17
  180. skippy@scat.cybernetics.net (Jeffrey Morgan) has subscribed to TESTLIST on 06-06-1995 at 18:22:58
  181. Removed <skippy@scat.cybernetics.net (Jeffrey Morgan)> from list: testlist on 06-07-1995 at 12:12:17
  182.  
  183. Beginning batch mail for list: testlist1 on 06-07-1995 at 16:14:42
  184.  
  185. Sending mail to: jerry@scat.cybernetics.net
  186. Sending mail to: funk@scat.cybernetics.net
  187. Sending mail to: stan@scat.cybernetics.net
  188. Sending mail to: love@scat.cybernetics.net
  189.  
  190. Ending batch mail for list: testlist1 on 06-07-1995 at 16:15:04
  191.  
  192.  
  193. As new commands are added, new logging messages will be added. Also, if
  194. for any reason the .names file cannot be found, an error will be logged.
  195.  
  196. NOTE*** Keep up with this file. If you have an active set of lists then
  197. this file can get quite large quite fast. Check it each day!
  198.  
  199.  
  200.                              Things you should know:
  201.  
  202. The only thing you need to know is a curious thing that I found
  203. when trying to reply to lists that I run. Using ELM 6 I could not get
  204. EZL to run when I posted to a list. I found that the problem was
  205. that I was addressing the mail to the full address of the mailing list
  206. which smtp.d noticed was local and thus bypassed the aliases file.
  207. Or...it would sometimes see it, but not always. I found that just
  208. addressing the list locally (programming instead of programming@scat.etc)
  209. will successfully send your post out to the world.
  210.  
  211. Also, PutMail does not do spooling so if you lose your connection then
  212. PutMail generates an error that is NOT logged.  It will also hang for
  213. a rediculous amount of time when your provider's smtphost is having a
  214. bad day. This is probably not PutMail's fault, but your provider's.
  215.  
  216. At this time you may see output to a shell if you post via a program
  217. that is launched from a shell.  I have left this in for debugging
  218. purposes and when I deem everything bug-free (yeah, right) then I
  219. will pipe it all to NIL:.
  220.  
  221.                              The Future:
  222.  
  223. I will be adding new commands as I can. Anything you would like
  224. to see, please email at the below address. I hope to someday add
  225. banning capabilities and MAYBE file getting, but the files stuff is
  226. WAY down the list. I don't like the security aspects of it.
  227.  
  228. If I can ever figure out the problems with SMTPpost and
  229. why it displaces my To: header (adds it at the end of the file
  230. when I use the -r flag) then I can make EZ-List more configurable
  231. so that it can use other mailers.
  232.  
  233.  
  234.                              THANX ETC:
  235.  
  236. I would like to than David Benn for ACE Basic Compiler. Good job!
  237.  
  238. Martin Lanza for his PutMail which handles forwarding of mail
  239. better than SMTPpost (IMHO). I am still trying to get SMTPpost to
  240. work, though so that spooling is possible.
  241.  
  242. Snapper Morgan for testing this program.
  243.  
  244. Kris Morgan for being such a cool wife!
  245.  
  246. The folks who wrote AMiTCP and to Michael Smith for his
  247. InetUtils.
  248.  
  249.  
  250.  
  251. LEGALITIES:
  252.  
  253. EZ-LIST IS FREELY DISTRIBUTABLE, NOT SHAREWARE, NOT PUBLIC DOMAIN.
  254.  
  255.  
  256. I GIVE NO WARRANTY FOR THIS PIECE OF SOFTWARE. NONE WHATSOEVER!
  257. SHOULD IT MANAGE SOMEHOW TO DELETE ANYTHING IMPORTANT, BREAK A
  258. DRIVE, SPOUT SHAKESPEARE (ALTHOUGH PLEASE WRITE ME IF IT DOES AS
  259. THAT IS DEFINITELY SOMETHING I WOULD LIKE TO SEE), OR CONSUME YOUR
  260. PETS THEN CONSIDER YOURSELF BEING VISITED BY KARMA, EQUALIZER OF
  261. THE UNIVERSE.
  262.  
  263. I GIVE PERMISSION TO REDISTRIBUTE EZ-LIST ONLY IN ITS ENTIRETY,
  264. INCLUDING THE PUTMAIL ARCHIVE, AND FOR THE DOCS TO ALWAYS
  265. REMAIN UNTOUCHED. YOU CANNOT MAKE ANY MONEY OTHER THAN COST
  266. RECOVERY FOR MATERIALS (IE DISK COSTS). AFTERALL, IF I DON'T
  267. MAKE ANY MONEY THEN WHY SHOULD YOU?
  268.  
  269. HAVE A NICE DAY :)
  270.  
  271.  
  272. Schrödinger's Cat Software is a trade mark of Schrödinger's Cat
  273. Services. All other mentioned or implied trademarks belong to
  274. their respective companies.
  275.  
  276. Putmail is the property of Martin Lanza. See included docs.
  277.  
  278. June 18, 1995
  279. Jeffrey S. Morgan
  280.  
  281.  
  282. WHY?
  283.  
  284. If you went all the way to the bottom of this document then you
  285. probably love my writing style so you went on, hoping for more.
  286. Well, here you go. I wrote this beast as a replacement for the 
  287. horrible program I wrote called Mailinglist Master.  It was written
  288. in CanDo and was a memory hungry beast that didn't recognize
  289. the two ways that an address can come in. Thankfully I wised
  290. up and wrote this. The basics only took me about a week to write
  291. with the tweaking that two more weeks can produce. ACE is a 
  292. wonderful thing.  It doesn't have all the bells and whistles,
  293. but it does the job. I hope you try it out.  Also, we take
  294. for granted being able to read e-mail without worrying about
  295. the headers, but they are fascinating stuff.  I don't 
  296. understand half of them, but they are still quite a piece of work.
  297.  
  298.